Skip to content

docs: improve doctests in complex/base/wrap-function#8666

Merged
kgryte merged 7 commits intostdlib-js:developfrom
aryan7071:docs/improve-doctests-complex/base/wrap-function
Dec 1, 2025
Merged

docs: improve doctests in complex/base/wrap-function#8666
kgryte merged 7 commits intostdlib-js:developfrom
aryan7071:docs/improve-doctests-complex/base/wrap-function

Conversation

@aryan7071
Copy link
Copy Markdown
Contributor

@aryan7071 aryan7071 commented Nov 30, 2025 •
edited by kgryte
Loading

Resolves a part of #8641

Description

What is the purpose of this pull request?

This pull request:

  • Updates REPL and documentation examples in the complex/base/wrap-function package to use the compact complex instance doctest notation.
  • Replaces example decomposition using realf/imagf with concise doctest annotations such as <Complex64>[ 7.0, 0.0 ].
  • Removes example-only imports (realf, imagf) where they were only used to show decomposed values.
  • Keeps all edits documentation-only (no runtime behavior or type changes).

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

(Replace the placeholder above with the relevant issue number if applicable.)

Questions

Any questions for reviewers of this pull request?

yes , in this example there is a whole function of realf and imagf so do i need to change it or not ?
image

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution.

N/A

@stdlib-js/reviewers

@stdlib-bot stdlib-bot added First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Needs Review A pull request which needs code review. labels Nov 30, 2025
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Nov 30, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
complex/base/wrap-function $\color{green}271/271$
$color{green}+100.00%$ 		$\color{green}35/35$
$color{green}+100.00%$ 		$\color{green}8/8$
$color{green}+100.00%$ 		$\color{green}271/271$
$color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Dec 1, 2025

⚠️ Tracking Issue Closure Warning ⚠️

I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue".

Why this matters:
Tracking issues should typically remain open until all related sub-issues are completed. GitHub automatically closes issues with such closing keywords when the PR is merged. For more information, see GitHub's documentation on using keywords in issues and pull requests.

Required action:
Use "Progresses" instead to reference the tracking issue without automatically closing it.

Thank you for your contribution to the project!

@stdlib-bot stdlib-bot added Potential Duplicate There might be another pull request resolving the same issue. and removed First-time Contributor A pull request from a contributor who has never previously committed to the project repository. labels Dec 1, 2025
@kgryte kgryte changed the title Docs/improve doctests complex/base/wrap function docs: improve doctests in complex/base/wrap function Dec 1, 2025
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Dec 1, 2025
@kgryte kgryte changed the title docs: improve doctests in complex/base/wrap function docs: improve doctests in complex/base/wrap-function Dec 1, 2025
@kgryte
Apply suggestions from code review
76d36f0 
Signed-off-by: Athan <kgryte@gmail.com>
kgryte
kgryte reviewed Dec 1, 2025
View reviewed changes
@kgryte
style: remove empty line
5a456e5 
Signed-off-by: Athan <kgryte@gmail.com>
kgryte
kgryte reviewed Dec 1, 2025
View reviewed changes
@kgryte
style: remove empty line
6ca1081 
Signed-off-by: Athan <kgryte@gmail.com>
kgryte
kgryte previously approved these changes Dec 1, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after clean-up

@kgryte
style: resolve lint error
c2d2b8d 
Signed-off-by: Athan <kgryte@gmail.com>
@kgryte kgryte merged commit 767edc7 into stdlib-js:develop Dec 1, 2025
12 checks passed
@aryan7071 aryan7071 mentioned this pull request Mar 19, 2026
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

Documentation Improvements, additions, or changes to documentation. Good First PR A pull request resolving a Good First Issue. Potential Duplicate There might be another pull request resolving the same issue.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aryan7071 @stdlib-bot @kgryte